1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260
//! Callback command types.
//!
//! These are returned to the callback function.
use crate::{bindings::VBVMR_CBCOMMAND, types::VoicemeeterApplication};
use super::data::{
AudioBuffer, AudioInfo, BufferInData, BufferMainData, BufferOutData, RawCallbackData,
};
macro_rules! implement {
(@audio_info $($name:ident),* $(,)?) => {
$(
impl HasAudioInfo for $name<'_> {
fn get(&self) -> &AudioInfo {
self.info
}
}
)*
};
(@audio_buffer $($name:ident),* $(,)?) => {
// $(
// impl HasAudioBuffer for $name<'_> {
// fn get(&self) -> &AudioBuffer {
// &self.buffer
// }
// fn get_mut(&mut self) -> &mut AudioBuffer {
// &mut self.buffer
// }
// }
// )*
};
}
implement! { @audio_info
Starting,
Ending,
Change,
}
implement! { @audio_buffer
BufferIn,
BufferOut,
BufferMain,
}
/// Callback command with audio info. Used to abstract away the command type in client code
pub trait HasAudioInfo {
/// Get the audio info.
fn get(&self) -> &AudioInfo;
}
/// Callback command with audio buffer. Used to abstract away the command type in client code
pub trait HasAudioBuffer {
/// Get the audio buffer.
fn get(&self) -> &AudioBuffer;
}
// FIXME: add .mds for these docs
/// Starting command.
#[derive(Debug)]
pub struct Starting<'a> {
/// Audio info
pub info: &'a AudioInfo,
}
impl<'a> Starting<'a> {
/// Create a new `Starting` command.
//#[tracing::instrument(skip_all, name = "Starting::new")]
pub(crate) fn new(info: &'a AudioInfo) -> Self {
Self { info }
}
}
/// Ending command.
#[derive(Debug)]
pub struct Ending<'a> {
/// Audio info
pub info: &'a AudioInfo,
}
impl<'a> Ending<'a> {
/// Create a new `Ending` command.
//#[tracing::instrument(skip_all, name = "Ending::new")]
pub(crate) fn new(info: &'a AudioInfo) -> Self {
Self { info }
}
}
/// Change command.
#[derive(Debug)]
pub struct Change<'a> {
/// Audio info
pub info: &'a AudioInfo,
}
impl<'a> Change<'a> {
/// Create a new `Change` command.
//#[tracing::instrument(skip_all, name = "Change::new")]
pub(crate) fn new(info: &'a AudioInfo) -> Self {
Self { info }
}
}
/// Data for input mode.
pub struct BufferIn<'a> {
/// Buffer data for input mode
pub buffer: BufferInData<'a>,
/// Sample rate
pub sr: usize,
/// Number of samples per frame
pub nbs: usize,
/// Total number of inputs in buffer.
pub nbi: usize,
/// Total number of outputs in buffer.
pub nbo: usize,
}
impl<'a> BufferIn<'a> {
//#[tracing::instrument(skip_all, name = "BufferIn::new")]
pub(crate) fn new(program: VoicemeeterApplication, buffer: &'a mut AudioBuffer) -> Self {
Self {
sr: buffer.audiobuffer_sr as usize,
nbs: buffer.audiobuffer_nbs as usize,
nbi: buffer.audiobuffer_nbi as usize,
nbo: buffer.audiobuffer_nbo as usize,
buffer: BufferInData::new(program, buffer, buffer.audiobuffer_nbs as usize),
}
}
}
/// Data for output mode.
pub struct BufferOut<'a> {
/// Sample rate
pub sr: usize,
/// Buffer data for output mode
pub buffer: BufferOutData<'a>,
/// Number of samples per frame
pub nbs: usize,
/// Total number of inputs in buffer.
pub nbi: usize,
/// Total number of outputs in buffer.
pub nbo: usize,
}
impl<'a> BufferOut<'a> {
//#[tracing::instrument(skip_all, name = "BufferOut::new")]
pub(crate) fn new(program: VoicemeeterApplication, buffer: &'a mut AudioBuffer) -> Self {
Self {
sr: buffer.audiobuffer_sr as usize,
nbs: buffer.audiobuffer_nbs as usize,
nbi: buffer.audiobuffer_nbi as usize,
nbo: buffer.audiobuffer_nbo as usize,
buffer: BufferOutData::new(program, buffer, buffer.audiobuffer_nbs as usize),
}
}
}
/// Data for main mode.
pub struct BufferMain<'a> {
/// Buffer data for main mode
pub buffer: BufferMainData<'a>,
/// Sample rate
pub sr: usize,
/// Number of samples per frame
pub nbs: usize,
/// Total number of inputs in buffer.
pub nbi: usize,
/// Total number of outputs in buffer.
pub nbo: usize,
}
impl<'a> BufferMain<'a> {
//#[tracing::instrument(skip_all, name = "BufferMain::new")]
pub(crate) fn new(program: VoicemeeterApplication, buffer: &'a mut AudioBuffer) -> Self {
Self {
sr: buffer.audiobuffer_sr as usize,
nbs: buffer.audiobuffer_nbs as usize,
nbi: buffer.audiobuffer_nbi as usize,
nbo: buffer.audiobuffer_nbo as usize,
buffer: BufferMainData::new(program, buffer, buffer.audiobuffer_nbs as usize),
}
}
}
/// Callback command passed to the [audio callback](crate::VoicemeeterRemote::audio_callback_register).
#[repr(i32)]
#[cfg(feature = "interface")] // for doc_cfg
#[allow(clippy::large_enum_variant)]
pub enum CallbackCommand<'a> {
/// Starting command
///
/// this is the first call of your Callback, made to let you initialize your
/// possible different DSP processing objects, allocate memory, precompute date...
Starting(Starting<'a>),
/// Ending command
///
/// this is the last call of your Callback, to release all your structure
/// previously allocated in the first call.
Ending(Ending<'a>),
/// Change command
///
/// this command is called if the samplerate or buffer size have changed
Change(Change<'a>),
/// BufferIn command
///
/// buffers for inputs
BufferIn(BufferIn<'a>),
/// BufferOut command
///
/// buffers for outputs
BufferOut(BufferOut<'a>),
/// BufferMain command
///
/// buffers for all i/o
BufferMain(BufferMain<'a>),
/// Other inknown command
Other(VBVMR_CBCOMMAND, RawCallbackData),
}
impl<'a> CallbackCommand<'a> {
/// Make a new callback command. This is not meant to be used in consumer code.
#[doc(hidden)]
pub unsafe fn new_unchecked(
program: VoicemeeterApplication,
command: VBVMR_CBCOMMAND,
ptr: RawCallbackData,
) -> Self {
match command {
VBVMR_CBCOMMAND::STARTING => {
Self::Starting(Starting::new(unsafe { ptr.as_audio_info() }))
}
VBVMR_CBCOMMAND::ENDING => Self::Ending(Ending::new(unsafe { ptr.as_audio_info() })),
VBVMR_CBCOMMAND::CHANGE => Self::Change(Change::new(unsafe { ptr.as_audio_info() })),
VBVMR_CBCOMMAND::BUFFER_IN => {
Self::BufferIn(BufferIn::new(program, unsafe { ptr.as_audio_buffer() }))
}
VBVMR_CBCOMMAND::BUFFER_OUT => {
Self::BufferOut(BufferOut::new(program, unsafe { ptr.as_audio_buffer() }))
}
VBVMR_CBCOMMAND::BUFFER_MAIN => {
Self::BufferMain(BufferMain::new(program, unsafe { ptr.as_audio_buffer() }))
}
i => Self::Other(i, ptr),
}
}
/// Get the command "name"
pub fn name(&self) -> Option<&'static str> {
Some(match self {
Self::Starting(_) => "Starting",
Self::Ending(_) => "Ending",
Self::Change(_) => "Change",
Self::BufferIn(_) => "BufferIn",
Self::BufferOut(_) => "BufferOut",
Self::BufferMain(_) => "BufferMain",
Self::Other(_, _) => return None,
})
}
}